<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Class template uniform_smallint</title>
<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
<link rel="up" href="../../boost_random/reference.html#doxygen.headers.uniform__smallint_8hpp" title="Header &lt;boost/random/uniform_smallint.hpp&gt;">
<link rel="prev" href="classboost_1_1random_1_1uniform__real__distribution_1_1param__type.html" title="Class param_type">
<link rel="next" href="classboost_1_1random_1_1uniform__smallint_1_1param__type.html" title="Class param_type">
<meta name="viewport" content="width=device-width, initial-scale=1">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
<td align="center"><a href="../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="classboost_1_1random_1_1uniform__real__distribution_1_1param__type.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_random/reference.html#doxygen.headers.uniform__smallint_8hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="classboost_1_1random_1_1uniform__smallint_1_1param__type.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="refentry">
<a name="doxygen.headers.classboost_1_1random_1_1uniform__smallint"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Class template uniform_smallint</span></h2>
<p>boost::random::uniform_smallint</p>
</div>
<h2 class="refsynopsisdiv-title">Synopsis</h2>
<div class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../../boost_random/reference.html#doxygen.headers.uniform__smallint_8hpp" title="Header &lt;boost/random/uniform_smallint.hpp&gt;">boost/random/uniform_smallint.hpp</a>&gt;

</span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> IntType <span class="special">=</span> <span class="keyword">int</span><span class="special">&gt;</span> 
<span class="keyword">class</span> <a class="link" href="classboost_1_1random_1_1uniform__smallint.html" title="Class template uniform_smallint">uniform_smallint</a> <span class="special">{</span>
<span class="keyword">public</span><span class="special">:</span>
  <span class="comment">// types</span>
  <span class="keyword">typedef</span> <span class="identifier">IntType</span> <a name="doxygen.headers.classboost_1_1random_1_1uniform__smallint_1a941ef0caf4510c2f4e63399d449c14a0"></a><span class="identifier">input_type</span><span class="special">;</span> 
  <span class="keyword">typedef</span> <span class="identifier">IntType</span> <a name="doxygen.headers.classboost_1_1random_1_1uniform__smallint_1a0595410ba2bf3b0d762d53b927bb1720"></a><span class="identifier">result_type</span><span class="special">;</span>

  <span class="comment">// member classes/structs/unions</span>

  <span class="keyword">class</span> <a class="link" href="classboost_1_1random_1_1uniform__smallint_1_1param__type.html" title="Class param_type">param_type</a> <span class="special">{</span>
  <span class="keyword">public</span><span class="special">:</span>
    <span class="comment">// types</span>
    <span class="keyword">typedef</span> <a class="link" href="classboost_1_1random_1_1uniform__smallint.html" title="Class template uniform_smallint">uniform_smallint</a> <a class="link" href="classboost_1_1random_1_1uniform__smallint_1_1param__type.html#doxygen.headers.classboost_1_1random_1_1uniform__smallint_1_1param__type_1a5e3aef3646f0c5a290b1db485751ace5"><span class="identifier">distribution_type</span></a><span class="special">;</span>

    <span class="comment">// <a class="link" href="classboost_1_1random_1_1uniform__smallint_1_1param__type.html#id-1_3_32_5_6_53_1_1_1_3_2-bb">public member functions</a></span>
    <a class="link" href="classboost_1_1random_1_1uniform__smallint_1_1param__type.html#doxygen.headers.classboost_1_1random_1_1uniform__smallint_1_1param__type_1a95f81bea70be57ffd3ac1b1d644f0d83"><span class="identifier">param_type</span></a><span class="special">(</span><span class="identifier">IntType</span> <span class="special">=</span> <span class="number">0</span><span class="special">,</span> <span class="identifier">IntType</span> <span class="special">=</span> <span class="number">9</span><span class="special">)</span><span class="special">;</span>
    <span class="identifier">IntType</span> <a class="link" href="classboost_1_1random_1_1uniform__smallint_1_1param__type.html#doxygen.headers.classboost_1_1random_1_1uniform__smallint_1_1param__type_1a9e93d1eb48476d44c11e9e5fd0ddcaf6"><span class="identifier">a</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
    <span class="identifier">IntType</span> <a class="link" href="classboost_1_1random_1_1uniform__smallint_1_1param__type.html#doxygen.headers.classboost_1_1random_1_1uniform__smallint_1_1param__type_1acd7575c48da9fd69087621850178141f"><span class="identifier">b</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>

    <span class="comment">// <a class="link" href="classboost_1_1random_1_1uniform__smallint_1_1param__type.html#id-1_3_32_5_6_53_1_1_1_3_3-bb">friend functions</a></span>
    <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> CharT<span class="special">,</span> <span class="keyword">typename</span> Traits<span class="special">&gt;</span> 
      <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ostream</span><span class="special">&lt;</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">&gt;</span> <span class="special">&amp;</span> 
      <a class="link" href="classboost_1_1random_1_1uniform__smallint_1_1param__type.html#doxygen.headers.classboost_1_1random_1_1uniform__smallint_1_1param__type_1a36d2820c7e758fa1a94fdd5d74949e54"><span class="keyword">operator</span><span class="special">&lt;&lt;</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ostream</span><span class="special">&lt;</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="classboost_1_1random_1_1uniform__smallint_1_1param__type.html" title="Class param_type">param_type</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
    <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> CharT<span class="special">,</span> <span class="keyword">typename</span> Traits<span class="special">&gt;</span> 
      <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_istream</span><span class="special">&lt;</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">&gt;</span> <span class="special">&amp;</span> 
      <a class="link" href="classboost_1_1random_1_1uniform__smallint_1_1param__type.html#doxygen.headers.classboost_1_1random_1_1uniform__smallint_1_1param__type_1aa94ff75dd5871ee80a6fc0a095c75bd0"><span class="keyword">operator</span><span class="special">&gt;&gt;</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_istream</span><span class="special">&lt;</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="classboost_1_1random_1_1uniform__smallint_1_1param__type.html" title="Class param_type">param_type</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
    <span class="keyword">bool</span> <a class="link" href="classboost_1_1random_1_1uniform__smallint_1_1param__type.html#doxygen.headers.classboost_1_1random_1_1uniform__smallint_1_1param__type_1ae6f3b58e629ce7a54b5e18a4f05dbc5a"><span class="keyword">operator</span><span class="special">==</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="classboost_1_1random_1_1uniform__smallint_1_1param__type.html" title="Class param_type">param_type</a> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="classboost_1_1random_1_1uniform__smallint_1_1param__type.html" title="Class param_type">param_type</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
    <span class="keyword">bool</span> <a class="link" href="classboost_1_1random_1_1uniform__smallint_1_1param__type.html#doxygen.headers.classboost_1_1random_1_1uniform__smallint_1_1param__type_1aa559d0d98e88e84417364a89b83cf5b2"><span class="keyword">operator</span><span class="special">!=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="classboost_1_1random_1_1uniform__smallint_1_1param__type.html" title="Class param_type">param_type</a> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="classboost_1_1random_1_1uniform__smallint_1_1param__type.html" title="Class param_type">param_type</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  <span class="special">}</span><span class="special">;</span>

  <span class="comment">// <a class="link" href="classboost_1_1random_1_1uniform__smallint.html#id-1_3_32_5_6_53_1_1_1_6-bb">public member functions</a></span>
  <span class="keyword">explicit</span> <a class="link" href="classboost_1_1random_1_1uniform__smallint.html#doxygen.headers.classboost_1_1random_1_1uniform__smallint_1aeee05f2fbb124a53e324f8242bc040ef"><span class="identifier">uniform_smallint</span></a><span class="special">(</span><span class="identifier">IntType</span> <span class="special">=</span> <span class="number">0</span><span class="special">,</span> <span class="identifier">IntType</span> <span class="special">=</span> <span class="number">9</span><span class="special">)</span><span class="special">;</span>
  <span class="keyword">explicit</span> <a class="link" href="classboost_1_1random_1_1uniform__smallint.html#doxygen.headers.classboost_1_1random_1_1uniform__smallint_1a7d8a5e437c764478cabcbc45b4df9b11"><span class="identifier">uniform_smallint</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="classboost_1_1random_1_1uniform__smallint_1_1param__type.html" title="Class param_type">param_type</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  <span class="identifier">result_type</span> <a class="link" href="classboost_1_1random_1_1uniform__smallint.html#doxygen.headers.classboost_1_1random_1_1uniform__smallint_1aca888905a25eb34f91c8d828870f621c"><span class="identifier">a</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  <span class="identifier">result_type</span> <a class="link" href="classboost_1_1random_1_1uniform__smallint.html#doxygen.headers.classboost_1_1random_1_1uniform__smallint_1a4748349f2c7af79e989dd3973b585290"><span class="identifier">b</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  <span class="identifier">result_type</span> <a class="link" href="classboost_1_1random_1_1uniform__smallint.html#doxygen.headers.classboost_1_1random_1_1uniform__smallint_1a527b01fcfa4c286f078096371d1e3c11"><span class="identifier">min</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  <span class="identifier">result_type</span> <a class="link" href="classboost_1_1random_1_1uniform__smallint.html#doxygen.headers.classboost_1_1random_1_1uniform__smallint_1a740e9eabaf87bbbfc57961836761c4f4"><span class="identifier">max</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  <a class="link" href="classboost_1_1random_1_1uniform__smallint_1_1param__type.html" title="Class param_type">param_type</a> <a class="link" href="classboost_1_1random_1_1uniform__smallint.html#doxygen.headers.classboost_1_1random_1_1uniform__smallint_1aec0d136cfafc3a3e02824be4e5e7bd3a"><span class="identifier">param</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  <span class="keyword">void</span> <a class="link" href="classboost_1_1random_1_1uniform__smallint.html#doxygen.headers.classboost_1_1random_1_1uniform__smallint_1aad65b1743eec84ebb04a7e313eca20a8"><span class="identifier">param</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="classboost_1_1random_1_1uniform__smallint_1_1param__type.html" title="Class param_type">param_type</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  <span class="keyword">void</span> <a class="link" href="classboost_1_1random_1_1uniform__smallint.html#doxygen.headers.classboost_1_1random_1_1uniform__smallint_1a9b57696c17992992ede493e6f80f7561"><span class="identifier">reset</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Engine<span class="special">&gt;</span> <span class="identifier">result_type</span> <a class="link" href="classboost_1_1random_1_1uniform__smallint.html#doxygen.headers.classboost_1_1random_1_1uniform__smallint_1af400c824a0bf9e1f297ece1cd345e399"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span></a><span class="special">(</span><span class="identifier">Engine</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Engine<span class="special">&gt;</span> 
    <span class="identifier">result_type</span> <a class="link" href="classboost_1_1random_1_1uniform__smallint.html#doxygen.headers.classboost_1_1random_1_1uniform__smallint_1aa1786e6e93f44b79b6cd4bddc3ae7fe4"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span></a><span class="special">(</span><span class="identifier">Engine</span> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="classboost_1_1random_1_1uniform__smallint_1_1param__type.html" title="Class param_type">param_type</a> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>

  <span class="comment">// <a class="link" href="classboost_1_1random_1_1uniform__smallint.html#id-1_3_32_5_6_53_1_1_1_7-bb">friend functions</a></span>
  <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> CharT<span class="special">,</span> <span class="keyword">typename</span> Traits<span class="special">&gt;</span> 
    <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ostream</span><span class="special">&lt;</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">&gt;</span> <span class="special">&amp;</span> 
    <a class="link" href="classboost_1_1random_1_1uniform__smallint.html#doxygen.headers.classboost_1_1random_1_1uniform__smallint_1abfedd3cad3924a6ff6306cefe70464b1"><span class="keyword">operator</span><span class="special">&lt;&lt;</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ostream</span><span class="special">&lt;</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">,</span> 
               <span class="keyword">const</span> <a class="link" href="classboost_1_1random_1_1uniform__smallint.html" title="Class template uniform_smallint">uniform_smallint</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> CharT<span class="special">,</span> <span class="keyword">typename</span> Traits<span class="special">&gt;</span> 
    <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_istream</span><span class="special">&lt;</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">&gt;</span> <span class="special">&amp;</span> 
    <a class="link" href="classboost_1_1random_1_1uniform__smallint.html#doxygen.headers.classboost_1_1random_1_1uniform__smallint_1a4472bc2906af87f5911ac36421399d0e"><span class="keyword">operator</span><span class="special">&gt;&gt;</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_istream</span><span class="special">&lt;</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">,</span> 
               <span class="keyword">const</span> <a class="link" href="classboost_1_1random_1_1uniform__smallint.html" title="Class template uniform_smallint">uniform_smallint</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  <span class="keyword">bool</span> <a class="link" href="classboost_1_1random_1_1uniform__smallint.html#doxygen.headers.classboost_1_1random_1_1uniform__smallint_1ab46d2b89e75259e73342a61b7c70ab4e"><span class="keyword">operator</span><span class="special">==</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="classboost_1_1random_1_1uniform__smallint.html" title="Class template uniform_smallint">uniform_smallint</a> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="classboost_1_1random_1_1uniform__smallint.html" title="Class template uniform_smallint">uniform_smallint</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  <span class="keyword">bool</span> <a class="link" href="classboost_1_1random_1_1uniform__smallint.html#doxygen.headers.classboost_1_1random_1_1uniform__smallint_1a95124e9d9e630ec50896ea205602829a"><span class="keyword">operator</span><span class="special">!=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="classboost_1_1random_1_1uniform__smallint.html" title="Class template uniform_smallint">uniform_smallint</a> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="classboost_1_1random_1_1uniform__smallint.html" title="Class template uniform_smallint">uniform_smallint</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
<span class="special">}</span><span class="special">;</span></pre></div>
<div class="refsect1">
<a name="id-1.3.32.5.6.52.3.4"></a><h2>Description</h2>
<p>The distribution function <a class="link" href="classboost_1_1random_1_1uniform__smallint.html" title="Class template uniform_smallint">uniform_smallint</a> models a  <a class="link" href="../../boost_random/reference.html#boost_random.reference.concepts.random_distribution" title="Random Distribution">random distribution</a> . On each invocation, it returns a random integer value uniformly distributed in the set of integer numbers {min, min+1, min+2, ..., max}. It assumes that the desired range (max-min+1) is small compared to the range of the underlying source of random numbers and thus makes no attempt to limit quantization errors.</p>
<p>Let <span class="inlinemediaobject"><img src="../../images/random//form_38.png"></span> the desired range of integer numbers, and let <span class="inlinemediaobject"><img src="../../images/random//form_39.png"></span> be the range of the underlying source of random numbers. Then, for the uniform distribution, the theoretical probability for any number i in the range <span class="inlinemediaobject"><img src="../../images/random//form_40.png"></span> will be <span class="inlinemediaobject"><img src="../../images/random//form_41.png"></span>. Likewise, assume a uniform distribution on <span class="inlinemediaobject"><img src="../../images/random//form_39.png"></span> for the underlying source of random numbers, i.e. <span class="inlinemediaobject"><img src="../../images/random//form_42.png"></span>. Let <span class="inlinemediaobject"><img src="../../images/random//form_43.png"></span> denote the random distribution generated by <code class="computeroutput"><a class="link" href="classboost_1_1random_1_1uniform__smallint.html" title="Class template uniform_smallint">uniform_smallint</a></code>. Then the sum over all i in <span class="inlinemediaobject"><img src="../../images/random//form_40.png"></span> of  <span class="inlinemediaobject"><img src="../../images/random//form_44.png"></span> shall not exceed   <span class="inlinemediaobject"><img src="../../images/random//form_45.png"></span>.</p>
<p>The template parameter IntType shall denote an integer-like value type.</p>
<p> </p>
<div class="note"><table border="0" summary="Note">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../doc/src/images/note.png"></td>
<th align="left">Note</th>
</tr>
<tr><td align="left" valign="top"><p>  The property above is the square sum of the relative differences in probabilities between the desired uniform distribution <span class="inlinemediaobject"><img src="../../images/random//form_46.png"></span> and the generated distribution <span class="inlinemediaobject"><img src="../../images/random//form_43.png"></span>. The property can be fulfilled with the calculation <span class="inlinemediaobject"><img src="../../images/random//form_47.png"></span>, as follows: Let <span class="inlinemediaobject"><img src="../../images/random//form_48.png"></span>. The base distribution on <span class="inlinemediaobject"><img src="../../images/random//form_39.png"></span> is folded onto the range <span class="inlinemediaobject"><img src="../../images/random//form_40.png"></span>. The numbers i &lt; r have assigned  <span class="inlinemediaobject"><img src="../../images/random//form_49.png"></span> numbers of the base distribution, the rest has only  <span class="inlinemediaobject"><img src="../../images/random//form_50.png"></span>. Therefore,    <span class="inlinemediaobject"><img src="../../images/random//form_51.png"></span> for i &lt; r and   <span class="inlinemediaobject"><img src="../../images/random//form_52.png"></span> otherwise. Substituting this in the above sum formula leads to the desired result.  </p></td></tr>
</table></div>
<p> </p>
<p>Note: The upper bound for  <span class="inlinemediaobject"><img src="../../images/random//form_53.png"></span> is <span class="inlinemediaobject"><img src="../../images/random//form_54.png"></span>. Regarding the upper bound for the square sum of the relative quantization error of <span class="inlinemediaobject"><img src="../../images/random//form_55.png"></span>, it seems wise to either choose <span class="inlinemediaobject"><img src="../../images/random//form_39.png"></span> so that <span class="inlinemediaobject"><img src="../../images/random//form_56.png"></span> or ensure that <span class="inlinemediaobject"><img src="../../images/random//form_39.png"></span> is divisible by <span class="inlinemediaobject"><img src="../../images/random//form_40.png"></span>. </p>
<div class="refsect2">
<a name="id-1.3.32.5.6.52.3.4.7"></a><h3>
<a name="id-1_3_32_5_6_53_1_1_1_6-bb"></a><code class="computeroutput">uniform_smallint</code> public member functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
<pre class="literallayout"><span class="keyword">explicit</span> <a name="doxygen.headers.classboost_1_1random_1_1uniform__smallint_1aeee05f2fbb124a53e324f8242bc040ef"></a><span class="identifier">uniform_smallint</span><span class="special">(</span><span class="identifier">IntType</span> min <span class="special">=</span> <span class="number">0</span><span class="special">,</span> <span class="identifier">IntType</span> max <span class="special">=</span> <span class="number">9</span><span class="special">)</span><span class="special">;</span></pre>
<p>Constructs a <code class="computeroutput"><a class="link" href="classboost_1_1random_1_1uniform__smallint.html" title="Class template uniform_smallint">uniform_smallint</a></code>. <code class="computeroutput">min</code> and <code class="computeroutput">max</code> are the lower and upper bounds of the output range, respectively. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">explicit</span> <a name="doxygen.headers.classboost_1_1random_1_1uniform__smallint_1a7d8a5e437c764478cabcbc45b4df9b11"></a><span class="identifier">uniform_smallint</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="classboost_1_1random_1_1uniform__smallint_1_1param__type.html" title="Class param_type">param_type</a> <span class="special">&amp;</span> param<span class="special">)</span><span class="special">;</span></pre>
<p>Constructs a <code class="computeroutput"><a class="link" href="classboost_1_1random_1_1uniform__smallint.html" title="Class template uniform_smallint">uniform_smallint</a></code> from its parameters. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="identifier">result_type</span> <a name="doxygen.headers.classboost_1_1random_1_1uniform__smallint_1aca888905a25eb34f91c8d828870f621c"></a><span class="identifier">a</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p>Returns the minimum value of the distribution. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="identifier">result_type</span> <a name="doxygen.headers.classboost_1_1random_1_1uniform__smallint_1a4748349f2c7af79e989dd3973b585290"></a><span class="identifier">b</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p>Returns the maximum value of the distribution. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="identifier">result_type</span> <a name="doxygen.headers.classboost_1_1random_1_1uniform__smallint_1a527b01fcfa4c286f078096371d1e3c11"></a><span class="identifier">min</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p>Returns the minimum value of the distribution. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="identifier">result_type</span> <a name="doxygen.headers.classboost_1_1random_1_1uniform__smallint_1a740e9eabaf87bbbfc57961836761c4f4"></a><span class="identifier">max</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p>Returns the maximum value of the distribution. </p>
</li>
<li class="listitem">
<pre class="literallayout"><a class="link" href="classboost_1_1random_1_1uniform__smallint_1_1param__type.html" title="Class param_type">param_type</a> <a name="doxygen.headers.classboost_1_1random_1_1uniform__smallint_1aec0d136cfafc3a3e02824be4e5e7bd3a"></a><span class="identifier">param</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p>Returns the parameters of the distribution. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">void</span> <a name="doxygen.headers.classboost_1_1random_1_1uniform__smallint_1aad65b1743eec84ebb04a7e313eca20a8"></a><span class="identifier">param</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="classboost_1_1random_1_1uniform__smallint_1_1param__type.html" title="Class param_type">param_type</a> <span class="special">&amp;</span> param<span class="special">)</span><span class="special">;</span></pre>
<p>Sets the parameters of the distribution. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">void</span> <a name="doxygen.headers.classboost_1_1random_1_1uniform__smallint_1a9b57696c17992992ede493e6f80f7561"></a><span class="identifier">reset</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
<p>Effects: Subsequent uses of the distribution do not depend on values produced by any engine prior to invoking reset. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Engine<span class="special">&gt;</span> <span class="identifier">result_type</span> <a name="doxygen.headers.classboost_1_1random_1_1uniform__smallint_1af400c824a0bf9e1f297ece1cd345e399"></a><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span><span class="special">(</span><span class="identifier">Engine</span> <span class="special">&amp;</span> eng<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p>Returns a value uniformly distributed in the range [<a class="link" href="classboost_1_1random_1_1uniform__smallint.html#doxygen.headers.classboost_1_1random_1_1uniform__smallint_1a527b01fcfa4c286f078096371d1e3c11">min()</a>, <a class="link" href="classboost_1_1random_1_1uniform__smallint.html#doxygen.headers.classboost_1_1random_1_1uniform__smallint_1a740e9eabaf87bbbfc57961836761c4f4">max()</a>]. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Engine<span class="special">&gt;</span> 
  <span class="identifier">result_type</span> <a name="doxygen.headers.classboost_1_1random_1_1uniform__smallint_1aa1786e6e93f44b79b6cd4bddc3ae7fe4"></a><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span><span class="special">(</span><span class="identifier">Engine</span> <span class="special">&amp;</span> eng<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="classboost_1_1random_1_1uniform__smallint_1_1param__type.html" title="Class param_type">param_type</a> <span class="special">&amp;</span> param<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p>Returns a value uniformly distributed in the range [param.a(), param.b()]. </p>
</li>
</ol></div>
</div>
<div class="refsect2">
<a name="id-1.3.32.5.6.52.3.4.8"></a><h3>
<a name="id-1_3_32_5_6_53_1_1_1_7-bb"></a><code class="computeroutput">uniform_smallint</code> friend functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
<pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> CharT<span class="special">,</span> <span class="keyword">typename</span> Traits<span class="special">&gt;</span> 
  <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ostream</span><span class="special">&lt;</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">&gt;</span> <span class="special">&amp;</span> 
  <a name="doxygen.headers.classboost_1_1random_1_1uniform__smallint_1abfedd3cad3924a6ff6306cefe70464b1"></a><span class="keyword">operator</span><span class="special">&lt;&lt;</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ostream</span><span class="special">&lt;</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">&gt;</span> <span class="special">&amp;</span> os<span class="special">,</span> 
             <span class="keyword">const</span> <a class="link" href="classboost_1_1random_1_1uniform__smallint.html" title="Class template uniform_smallint">uniform_smallint</a> <span class="special">&amp;</span> ud<span class="special">)</span><span class="special">;</span></pre>
<p>Writes the distribution to a <code class="computeroutput">std::ostream</code>. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> CharT<span class="special">,</span> <span class="keyword">typename</span> Traits<span class="special">&gt;</span> 
  <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_istream</span><span class="special">&lt;</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">&gt;</span> <span class="special">&amp;</span> 
  <a name="doxygen.headers.classboost_1_1random_1_1uniform__smallint_1a4472bc2906af87f5911ac36421399d0e"></a><span class="keyword">operator</span><span class="special">&gt;&gt;</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_istream</span><span class="special">&lt;</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">&gt;</span> <span class="special">&amp;</span> is<span class="special">,</span> 
             <span class="keyword">const</span> <a class="link" href="classboost_1_1random_1_1uniform__smallint.html" title="Class template uniform_smallint">uniform_smallint</a> <span class="special">&amp;</span> ud<span class="special">)</span><span class="special">;</span></pre>
<p>Reads the distribution from a <code class="computeroutput">std::istream</code>. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">bool</span> <a name="doxygen.headers.classboost_1_1random_1_1uniform__smallint_1ab46d2b89e75259e73342a61b7c70ab4e"></a><span class="keyword">operator</span><span class="special">==</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="classboost_1_1random_1_1uniform__smallint.html" title="Class template uniform_smallint">uniform_smallint</a> <span class="special">&amp;</span> lhs<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="classboost_1_1random_1_1uniform__smallint.html" title="Class template uniform_smallint">uniform_smallint</a> <span class="special">&amp;</span> rhs<span class="special">)</span><span class="special">;</span></pre>
<p>Returns true if the two distributions will produce identical sequences of values given equal generators. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">bool</span> <a name="doxygen.headers.classboost_1_1random_1_1uniform__smallint_1a95124e9d9e630ec50896ea205602829a"></a><span class="keyword">operator</span><span class="special">!=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="classboost_1_1random_1_1uniform__smallint.html" title="Class template uniform_smallint">uniform_smallint</a> <span class="special">&amp;</span> lhs<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="classboost_1_1random_1_1uniform__smallint.html" title="Class template uniform_smallint">uniform_smallint</a> <span class="special">&amp;</span> rhs<span class="special">)</span><span class="special">;</span></pre>
<p>Returns true if the two distributions may produce different sequences of values given equal generators. </p>
</li>
</ol></div>
</div>
</div>
</div>
<div class="copyright-footer">Copyright © 2000-2005 Jens Maurer<br>Copyright © 2009, 2010 Steven Watanabe<br>Copyright © 2022-2025 Matt
      Borland<p>
        Distributed under the Boost Software License, Version 1.0. (See accompanying
        file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
      </p>
</div>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="classboost_1_1random_1_1uniform__real__distribution_1_1param__type.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_random/reference.html#doxygen.headers.uniform__smallint_8hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="classboost_1_1random_1_1uniform__smallint_1_1param__type.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>
